Database Batch Import

On the Database Batch Import screen, you need to set up batches of imported files, and specify import settings.

Security permissions based on workgroups and user accounts can be applied to batch import settings. Use Permissions in the Batch import settings dropdown menu to access the Permissions dialog. Access to batch management controls (save, edit, rename, delete, etc.) will depend on the 'effective permissions' which are granted to each user's account (i.e., the combination of user-level permissions and any workgroup permissions affecting that user).

Set up import batches

Each tab on the Database Batch Import screen corresponds to an import batch. Batches are used to load files from several locations at once, or to load the same set of files with different settings. Each batch is processed completely before the loader moves on to the next batch. Batch management buttons are described in the table below; the same functions are available in the context menu if you right-click a batch tab.

Note: The import begins with projects at the left-most batch tab and proceeds from left to right. Each batch is processed completely before the data loader moves on to the next batch.

Button Description
New Tab button Creates a new batch.
The Rename button Renames the selected batch.
Delete Tab button Deletes the selected batch.
Move Tab Left button Moves the selected batch to the left.
Move Tab Right button Moves the selected batch to the right.

Select files to import

If the selected mapping template contains a valid database connection it will be connected immediately and the field on the left will be filled with a file structure extracted from the database. If there is no connection you will need to edit the template and check the connection settings, or use a different template.

In the file structure shown, check the boxes for the items you want to import.

You can use CTRL+A to Select All files, or SHIFT+CTRL+A to Deselect All files; these are also clickable actions in the right-click context menu.

You can use the check box Load All Items to automatically select all items in the file structure. When this setting is used, the manual selection of source files will be ignored.

Specify import settings

Note: Settings in the right-hand pane apply to individual batches. Thus, you can select different import options for each set of imported files.

New Documents setting:

Option Description
Create document If a document does not already exist, it will be created.
Ignore document (do not add) If a document does not already exist, it will not be imported.

Existing Documents settings:

Option Description
Update document Existing documents will be updated with values from the imported data if they exist directly under the node selected as the destination document for the import.
Update document at any root

Existing documents will be updated if they exist on any hierarchy level under the document that is selected as the destination document for the import.

Important: If you have several documents with the same name, only the first found document will be updated.

Update document using identifier

This option will load source data into multiple documents, i.e., all documents that match with the specified identifier. This is specified using the settings Document ID and Document ID Property in the Template editor Settings dialog.

Create additional document A copy of the existing document will be created and populated with values from the imported data.
Log and skip document Existing documents will be not be updated, and a record will be made in the log file.
Override start date [Enabled when an 'Update...' option is selected] Check this box to override the document's start date with the date specified in the mapping template. This will enable the Data Options button, which opens a dialog where you can select to shift or truncate variable data.

Document Scenario settings: These settings specify the scenarios for imported documents. If Use Setting from Mapping Template is selected then the scenario setting in the mapping template will be used. If Import into Scenario is selected then you specify a scenario using the dropdown selector. Check the option Create if not found to create a new scenario when it does not exist in a document.

Imported values will be saved in the destination Dataflow documents as a new revision. In the Revision Comments field, enter comments in the same way that you would when saving documents in Dataflow. You can also specify a Revision Tag.

Batch Settings management

You can store batch import settings for reuse later. To open a stored configuration, select it from the list in the Batch import settings field at the top of the screen. Next to this field is a drop-down menu with settings management options, which are explained in the table below. You can export a stored configuration to a 'XET' file in the local file system, and import configurations from XET files (you can use this feature to move configurations between different Planning Space tenants, for example).

Option Description
New Settings Creates a new stored configuration.
Save Settings Saves the current on-screen settings into the currently-selected configuration.
Rename Settings Renames the selected stored configuration.
Delete Settings Deletes the selected stored configuration.
Import Settings Import a settings configuration from a local file (XET format).
Export Settings Export a settings configuration to a local file (XET format).
View All Settings (only for the Economics and Financials loaders) This contains the utilities Export to CSV to export settings into a CSV file, and Copy Settings Between Batches to optionally copy settings values between batch tabs.

Security permissions for Batch Settings

Security permissions based on workgroups and user accounts can be applied to batch import settings. Use Permissions in the Batch import settings dropdown menu to access the Permissions dialog.

Access to batch management controls (save, edit, rename, delete, etc.) will depend on the 'effective permissions' which are granted to each user's account (i.e., the combination of user-level permissions and any workgroup permissions affecting that user).